/*
 * Copyright 2010-2012 Susanta Tewari. <freecode4susant@users.sourceforge.net>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package bd.org.apache.commons.math.exception;

import bd.org.apache.commons.math.exception.util.Localizable;
import bd.org.apache.commons.math.exception.util.LocalizedFormats;

/**
 * Exception to be thrown when a number is too large.
 *
 * @version $Id$
 * @since 2.2
 */
public class NumberIsTooLargeException extends MathIllegalNumberException {

    /**
     * Serializable version Id.
     */
    private static final long serialVersionUID = 4330003017885151975L;

    /**
     * Higher bound.
     */
    private final Number max;

    /**
     * Whether the maximum is included in the allowed range.
     */
    private final boolean boundIsAllowed;

    /**
     * Construct the exception.
     *
     * @param wrong Value that is larger than the maximum.
     * @param max Maximum.
     * @param boundIsAllowed if true the maximum is included in the allowed range.
     */
    public NumberIsTooLargeException(Number wrong, Number max, boolean boundIsAllowed) {

        this(boundIsAllowed
             ? LocalizedFormats.NUMBER_TOO_LARGE
             : LocalizedFormats.NUMBER_TOO_LARGE_BOUND_EXCLUDED, wrong, max, boundIsAllowed);
    }

    /**
     * Construct the exception with a specific context.
     *
     * @param specific Specific context pattern.
     * @param wrong Value that is larger than the maximum.
     * @param max Maximum.
     * @param boundIsAllowed if true the maximum is included in the allowed range.
     */
    public NumberIsTooLargeException(Localizable specific, Number wrong, Number max,
                                     boolean boundIsAllowed) {

        super(specific, wrong, max);

        this.max            = max;
        this.boundIsAllowed = boundIsAllowed;
    }

    /**
     * @return {@code true} if the maximum is included in the allowed range.
     */
    public boolean getBoundIsAllowed() {

        return boundIsAllowed;
    }


    /**
     * @return the maximum.
     */
    public Number getMax() {

        return max;
    }
}
